Skip to content

feat(conventional_commits): Add exclamation on commit title for breaking change#1576

Merged
Lee-W merged 2 commits intocommitizen-tools:v4-9-2from
bastien31:dev/sfusilier/exclamation_bc_cc
Nov 8, 2025
Merged

feat(conventional_commits): Add exclamation on commit title for breaking change#1576
Lee-W merged 2 commits intocommitizen-tools:v4-9-2from
bastien31:dev/sfusilier/exclamation_bc_cc

Conversation

@bastien31
Copy link
Contributor

@bastien31 bastien31 commented Aug 12, 2025 •
edited
Loading

Add a configuration (disable by default) to allow exclamation in commit title to ease identify BC simple git log parsing.

Description

Conventional commit allow to put breaking change exclamation character in git commit title.
This is a useful convention to identify BC commit from the title only.
As it is supported in commitizen parsing, add the option to generate it.

Checklist

Code Changes

  • Add test cases to all the changes you introduce
  • Run poetry all locally to ensure this change passes linter check and tests
  • Manually test the changes:
    • Verify the feature/bug fix works as expected in real-world scenarios
    • Test edge cases and error conditions
    • Ensure backward compatibility is maintained
    • Document any manual testing steps performed
  • Update the documentation for the changes

Documentation Changes

  • Run poetry doc locally to ensure the documentation pages renders correctly
  • Check and fix any broken links (internal or external) in the documentation

When running poetry doc, any broken internal documentation links will be reported in the console output like this:

INFO    -  Doc file 'config.md' contains a link 'commands/bump.md#-post_bump_hooks', but the doc 'commands/bump.md' does not contain an anchor '#-post_bump_hooks'.

Expected Behavior

Steps to Test This Pull Request

Additional Context

@bastien31 bastien31 changed the title Allow exclamation on breaking change for conventional commit [draft] Allow exclamation on breaking change for conventional commit Aug 12, 2025
@bastien31 bastien31 marked this pull request as draft August 12, 2025 11:13
@bastien31 bastien31 changed the title [draft] Allow exclamation on breaking change for conventional commit Allow exclamation on breaking change for conventional commit Aug 12, 2025
@bastien31 bastien31 force-pushed the dev/sfusilier/exclamation_bc_cc branch from 79a72cd to dad2e40 Compare August 12, 2025 11:21
@codecov
Copy link

codecov bot commented Aug 12, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (v4-9-2@835ccb4). Learn more about missing BASE report.

Additional details and impacted files 
@@            Coverage Diff            @@
##             v4-9-2    #1576   +/-   ##
=========================================
  Coverage          ?   98.72%           
=========================================
  Files             ?       60           
  Lines             ?     2667           
  Branches          ?        0           
=========================================
  Hits              ?     2633           
  Misses            ?       34           
  Partials          ?        0
Flag Coverage Δ
unittests 98.72% <100.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@bastien31 bastien31 changed the title Allow exclamation on breaking change for conventional commit Add exclamation on breaking change for conventional commit Aug 12, 2025
@bastien31 bastien31 changed the title Add exclamation on breaking change for conventional commit Add exclamation on commit title for breaking change for conventional commit Aug 12, 2025
@bastien31 bastien31 changed the title Add exclamation on commit title for breaking change for conventional commit feat(conventional_commits): Add exclamation on commit title for breaking change Aug 12, 2025
@bastien31
Copy link
Contributor Author

bastien31 commented Aug 12, 2025

Tested manually:
image
image

@bastien31 bastien31 marked this pull request as ready for review August 13, 2025 06:12
@github-actions github-actions bot added the type: feature A new enhacement proposal label Aug 13, 2025
@Lee-W Lee-W changed the base branch from master to v4-9-0-test August 13, 2025 13:34
@Lee-W Lee-W added this to the 4.9.0 milestone Aug 13, 2025
@bastien31 bastien31 force-pushed the dev/sfusilier/exclamation_bc_cc branch 2 times, most recently from cf7c06d to f69f73f Compare September 1, 2025 14:34
@Lee-W Lee-W modified the milestones: 4.9.0, 4.10.0 Sep 9, 2025
@Lee-W Lee-W deleted the branch commitizen-tools:v4-9-2 September 9, 2025 06:09
@Lee-W Lee-W closed this Sep 9, 2025
@Lee-W Lee-W reopened this Sep 9, 2025
@Lee-W Lee-W changed the base branch from v4-9-0-test to master September 9, 2025 06:19
@bastien31 bastien31 force-pushed the dev/sfusilier/exclamation_bc_cc branch from f69f73f to 186fbd8 Compare September 9, 2025 13:47
@bastien31
Copy link
Contributor Author

bastien31 commented Sep 9, 2025 •
edited
Loading

After a rebase on master, I had to add following fix 186fbd83fc7d2fa8c363fa2a08a7d901a657517c to get tests passed.
Also, on my side, I need to add "deprecated" library to get commitizen running.

@Lee-W
Copy link
Member

Lee-W commented Sep 9, 2025

yep, this needs #1591 to be merged

bearomorphism
bearomorphism reviewed Sep 21, 2025
View reviewed changes
bearomorphism
bearomorphism reviewed Sep 21, 2025
View reviewed changes
bearomorphism
bearomorphism reviewed Sep 21, 2025
View reviewed changes
@bastien31 bastien31 force-pushed the dev/sfusilier/exclamation_bc_cc branch from 186fbd8 to 2dac9eb Compare October 3, 2025 07:19
@bastien31
Copy link
Contributor Author

bastien31 commented Nov 7, 2025

Ready for review.

@Lee-W Lee-W changed the base branch from master to v4-9-2 November 8, 2025 08:06
@Lee-W Lee-W modified the milestones: 4.11.0, 4.10.0 Nov 8, 2025
@Lee-W Lee-W changed the base branch from v4-9-2 to master November 8, 2025 08:06
@Lee-W Lee-W changed the base branch from master to v4-9-2 November 8, 2025 08:49
@bastien31 @Lee-W
feat(conventional_commits): allow exclamation in title on BC
087580c 
Add a configuration (disable by default) to allow exclamation in
commit title to ease identify BC simple git log parsing.

Signed-off-by: Sebastien Fusilier <[email protected]>
@Lee-W Lee-W force-pushed the dev/sfusilier/exclamation_bc_cc branch from 2dac9eb to e923fc7 Compare November 8, 2025 08:54
@Lee-W Lee-W added pr-status: ready-to-merge almost ready to merge. just keep it for a few days for others to check and removed pr-status: wait-for-review labels Nov 8, 2025
@Lee-W Lee-W force-pushed the dev/sfusilier/exclamation_bc_cc branch from e923fc7 to 2856582 Compare November 8, 2025 09:37
@bastien31 @Lee-W
fix(test): set terminal width for cli tests
c995c38 
Force consistent terminal width for tests to avoid wrapping differences
between single and multi-worker pytest modes

Signed-off-by: Sebastien Fusilier <[email protected]>
@Lee-W Lee-W force-pushed the dev/sfusilier/exclamation_bc_cc branch from 2856582 to c995c38 Compare November 8, 2025 10:03
@Lee-W Lee-W merged commit f73d1bb into commitizen-tools:v4-9-2 Nov 8, 2025
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bearomorphism bearomorphism bearomorphism left review comments

@woile woile woile approved these changes

@Lee-W Lee-W Lee-W approved these changes

@noirbizarre noirbizarre Awaiting requested review from noirbizarre

Assignees

No one assigned

Labels

pr-status: ready-to-merge almost ready to merge. just keep it for a few days for others to check pr-status: wait-for-review type: feature A new enhacement proposal

Projects

None yet

Milestone

4.10.0

Development

Successfully merging this pull request may close these issues.

4 participants

@bastien31 @Lee-W @woile @bearomorphism